Design documentation
Contents |
[edit] Introduction
Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent record keeping. A document is a representation of information in a written, drawn or digital form.
Design documentation is a term that is sometimes associated with the development of computer software (as in architecture design documentation) and web design (as in user experience or UX). In Design Documentation: Why You Need It, Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:
- Making documentation usable for the target audience.
- Providing up-to-date documentation.
- Working on design documentation incrementally.
- Testing documentation.
- Avoiding jargon.
- Creating easy access.
- Providing visual samples in the documentation.
Generally, this sort of design documentation should include information about users, implementation details, agreed upon decisions and project deadlines. The creation of design documentation should take place during the early stages of a project in order to clarify expectations and expedite the achievement of goals.
[edit] Building design documentation
These same basic principles can apply to design documentation for building and construction. At the very least, there should be a suitable amount of documentation written to inform staff at an appropriate level of the work that they are expected to complete.
Ideally, this collection of documents and resources should cover all design aspects of a building project, including decisions that have been made during the design process to satisfy business, legal, environmental, social, technical and so on requirements and support the execution of the design.
This can include specifications, drawings, operational information, and other relevant documents (explanatory diagrams, tables and charts, standards, surveys and so on).
The amount and depth of the documentation will depend on the requirements of the design brief, and other documentation such as employers information requirements.
There are a number of articles on Designing Buildings describing particular types of documentation and documents:
- Contract documents.
- Tender documentation.
- Types of drawings.
- Briefing documents.
- Specifications.
- Legislation.
- Regulations.
- Planning permission.
- Certificates.
- Permits.
- Approvals.
- BIM.
- Construction contract certificates, notices and instructions.
For more information see: Design process.
[edit] Related articles on Designing Buildings
- Commissioning documentation.
- Document.
- Handover to client.
- Project brief for design and construction.
- Quality management systems (QMS) - beyond the documentation.
- Record keeping.
- User experience UX.
[edit] External resources
- Nick Babich, Design Documentation: Why You Need It.
Featured articles and news
Twas the site before Christmas...
A rhyme for the industry and a thankyou to our supporters.
Plumbing and heating systems in schools
New apprentice pay rates coming into effect in the new year
Addressing the impact of recent national minimum wage changes.
EBSSA support for the new industry competence structure
The Engineering and Building Services Skills Authority, in working group 2.
Notes from BSRIA Sustainable Futures briefing
From carbon down to the all important customer: Redefining Retrofit for Net Zero Living.
Principal Designer: A New Opportunity for Architects
ACA launches a Principal Designer Register for architects.
A new government plan for housing and nature recovery
Exploring a new housing and infrastructure nature recovery framework.
Leveraging technology to enhance prospects for students
A case study on the significance of the Autodesk Revit certification.
Fundamental Review of Building Regulations Guidance
Announced during commons debate on the Grenfell Inquiry Phase 2 report.
CIAT responds to the updated National Planning Policy Framework
With key changes in the revised NPPF outlined.
Councils and communities highlighted for delivery of common-sense housing in planning overhaul
As government follows up with mandatory housing targets.
CIOB photographic competition final images revealed
Art of Building produces stunning images for another year.
HSE prosecutes company for putting workers at risk
Roofing company fined and its director sentenced.
Strategic restructure to transform industry competence
EBSSA becomes part of a new industry competence structure.
Major overhaul of planning committees proposed by government
Planning decisions set to be fast-tracked to tackle the housing crisis.
Industry Competence Steering Group restructure
ICSG transitions to the Industry Competence Committee (ICC) under the Building Safety Regulator (BSR).
Principal Contractor Competency Certification Scheme
CIOB PCCCS competence framework for Principal Contractors.
The CIAT Principal Designer register
Issues explained via a series of FAQs.